home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / program / nxdv99_3.zip / NXMCI.DOC < prev    next >
Text File  |  1996-06-19  |  13KB  |  306 lines
  1.                          Next Epoch matriX User System
  2.                           Third Party Development Kit
  3.  
  4.  
  5.       (c) Copyright 1996 Intuitive Vision Software.  All Rights Reserved.
  6. ------------------------------------------------------------------------------
  7.  
  8.  
  9. Intuitive Vision Software 
  10. MCI Code Information      :  NXMCI.DOC
  11.  
  12. Revision Number           :  0.99.02
  13. Revision Date             :  19 Jun 96
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                              -Table of Contents-
  21.  
  22.  
  23.            I.  MCI Codes: What are they?                       2
  24.  
  25.           II.  MCI Codes: General Notes                        2
  26.  
  27.          III.  MCI Code Subsystems:                            2
  28.  
  29.           IV.  -  Strings                                      2
  30.                     -  File System                             2
  31.                     -  Message System                          2
  32.                     -  User Reference                          3
  33.                     -  General                                 3
  34.  
  35.            V.  -  Quote Headers/Footers                        3
  36.  
  37.           VI.  -  Archivers                                    3
  38.  
  39.  
  40.  
  41.  
  42. MCI CODES: WHAT ARE THEY?
  43.  
  44.         MCI codes are String Codes that allow the sysop to define certain
  45. elements in the Nexus system.  There are a couple of different subsystems,
  46. each having their own set of codes, but all following basically the same
  47. format.  MCI codes allow the sysop to place a code in certain places, such
  48. as menus, sysop definable strings, protocol commandlines, archiver
  49. commandlines, etc., that will be replaced with current information when
  50. used.  In other words, you can place a code for the filename in the
  51. protocol commandline and it will be replaced with the appropriate filename
  52. when that protocol is used.  You can also do something such as place an MCI
  53. code for the user's alias in the menu prompt.  This would be replaced with
  54. the current user's alias when the menu is displayed.
  55.         MCI codes allow for flexible use of the Nexus system, and will most
  56. definately make your bbs more original.
  57.  
  58.  
  59.  
  60.  
  61.  
  62. MCI CODES: GENERAL NOTES
  63.  
  64.         First of all, make sure that you understand that not all of the
  65. MCI codes work everywhere.  This document will detail where each set of MCI
  66. codes work, and make sure you follow these rules, or else you will have
  67. problems.  MCI codes are NOT case sensitive.  You can use either upper or
  68. lower case in any of the MCI codes.  In the protocol sub-system, the MCI
  69. codes for the paths do NOT end with a backslash (\).
  70.  
  71.  
  72.  
  73.  
  74.  
  75. MCI Code Subsystems:  STRINGS
  76.  
  77.         The MCI codes for Strings are valid in all of the following places:
  78. Menus (as string displays (command 02), as prompts, in titles, etc), system
  79. strings (except quote headers/footers), and in ascii and ansi files.  The 
  80. following categories have been provided so that you can relate to which MCI 
  81. codes do what:
  82.  
  83.         File System
  84.  
  85.         |FBNUMBER|         Current File Base Number
  86.         |FBNAME|           Current File Base Name
  87.         |FBASE|            Current File Base Number AND Name
  88.         |DLFLAG|           Number Of Files Currently Flagged For Download
  89.         |ULFLAG|           Number Of Files Currently Flagged For Upload
  90.         |ULDLKB|           UL/DL Ratio in Kilobytes (10k to 100k)
  91.         |ULDLNUM|          UL/DL Ratio in Files (1 to 3)
  92.         |FBFREE|           Current Kilobytes Free in Current Base
  93.         |FPOINTS|          Current User's Number of File Points
  94.         |FCONF|            Current File Conference Letter
  95.         |FCONFNAME|        Current File Conference Name
  96.  
  97.         File Listing
  98.  
  99.         These MCI codes are only valid during file listing, and will not
  100.         work appropriately anywhere else.
  101.  
  102.         |FLFLAGGED|        STRING #369 if flagged, #368 if not
  103.         |FLNEW|            STRING #381 if new, #380 if not
  104.         |FLNUM|            The file number
  105.         |FLNAME|           The file name
  106.         |FLMAGIC|          The file's magic name
  107.         |FLDESC|           This will return the current description line.
  108.                            Nexus automatically increments the current line
  109.                            number after displaying a description line.
  110.         |FLPTS|            Filepoints
  111.         |FLULDATE|         Uploaded date
  112.         |FLULBY|           Uploaded by
  113.         |FLDL|             Number of downloads
  114.         |FLSIZE|           File size
  115.         |FLSTAT|           Statistics
  116.                            
  117.         Message System
  118.  
  119.         |MBNUMBER|         Current Message Base Number
  120.         |MBNAME|           Current Message Base Name
  121.         |MBASE|            Current Message Base Number AND Name
  122.         |CURMSG|           Current Message Number in Current Base
  123.         |HIGHMSG|          Number of Messages In Current Base
  124.         |MAXLINES|         Maximum Lines Allowed When Entering Message
  125.         |MCONF|            Current Message Conference Letter
  126.         |MCONFNAME|        Current Message Conference Name
  127.         |NUMEDITORS|       The number of external editors configured on
  128.                                 this system
  129.         |CUREDITOR|        The name of the currently selected editor
  130.  
  131.         Message Reading/Listing
  132.  
  133.         These MCI codes are for use in the message reading/message listing
  134.         portions of Nexus, and will not function correctly anywhere else.
  135.  
  136.         MSGNEW             Whether the current message is new or not
  137.                            This MCI code will return either STRING #679
  138.                            if it is new or blank if not.
  139.         MSGTO              The TO name of the current message
  140.         MSGFROM            The FROM name of the current message
  141.         MSGDATE            The DATE of the current message
  142.         MSGTIME            The TIME of the current message
  143.         MSGSUBJ            The SUBJECT of the current message
  144.         MSGFLAGS           The flags of the current message
  145.         MSGREFER           The message number to refer to or blank if none
  146.         MSGNEXT            The next message in thread or blank if none
  147.  
  148.         Node Activity
  149.  
  150.         These MCI codes are for use when display who's on what node, and
  151.         the internode messages.  The will not function correctly anywhere
  152.         else.
  153.  
  154.         |NLNODE|           Node Number
  155.         |NLNAME|           User's Name
  156.         |NLFROM|           Calling From
  157.         |NLAVAIL|          Whether the user is available for chat or not
  158.         |NLACT|            Current Activity
  159.  
  160.         User Reference
  161.  
  162.         |UALIAS|           Current User's Alias (Handle)
  163.         |UREAL|            Current User's FULL Real Name
  164.         |UNAME|            Current User's name.  Nexus will determine whether
  165.                                 to return the real name or alias, based on
  166.                                 the settings for Alias as Primary Name
  167.         |UFIRST|           Current User's Real First Name
  168.         |ULAST|            Current User's Real Last Name
  169.         |UTITLE|           Current User's Title
  170.         |SLEVEL|           Current User's Security Level
  171.         |SLDESC|           Current User's Security Level Description
  172.         |SUBDESC|          Current User's Subscription Level Description
  173.         |SUBLEFT|          Number of days left in user's subscription
  174.         |SUBDAYS|          Number of days total in user's subscription
  175.         |TIMELEFT|         Current User's Remaining Time Online
  176.         |UACCKEY|          Current User's Access Key
  177.         |UZIPCODE|         Current User's Zip Code
  178.         |UTERM|            Current User's Terminal Emulation
  179.         |UGENDER|          Current User's Gender
  180.         |ULASTON|          Current User's Last On Date
  181.         |UCALLFROM|        Current User's Calling From
  182.         |UADDRESS1|        Current User's Address Line 1
  183.         |UADDRESS2|        Current User's Address Line 2
  184.         |UCITYST|          Current User's City, State
  185.         |UZIPCODE|         Current User's Zipcode
  186.         |UPHONEx|          Current User's Phone #x (where x is 1-4)
  187.         |TIMEB